Data parity for seasons and episodes by Touchstone64 · Pull Request #1593 · pushingkarmaorg/python-plexapi

Touchstone64 · 2026-03-13T20:30:02Z

Description

This PR includes a mixin supporting a key builder suitable for all TV parent/child searches, including guids unless specifically instructed otherwise, and implements it for all object-retrieving methods as described in #1592.

Fixes #1592

Type of change

Please delete options that are not relevant.

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added or updated the docstring for new or existing methods
I have added tests when applicable

In all honesty I've had great difficulty setting up an 'all-tests-pass' test harness with tools/plex-bootstraptest.py, but I have been able to use it to create an environment that could run the new unit tests individually. The new tests all fail when the mixin's _buildRelationKey() includeGuids code is commented out, and pass when it's reinstated, so I'm happy that the changes are effective and the unit tests are of value.

Please feel free to make or suggest any changes that would help pull this PR into line with the spirit of this repo.

…chSeasons() and searchEpisodes() methods and Show.seasons() and Season.episodes() methods

Touchstone64 · 2026-03-14T10:56:45Z

I'm out of depth trying to solve the failing CI step as I'm unfamiliar with Github actions, but I'll do some research and see if I can offer any solutions.

JonnyWong16 · 2026-03-14T17:02:32Z

The test failure is just a caching issue.

Copilot

Pull request overview

Adds a TV parent/child relation key builder to align GUID inclusion across show/season/episode “member” retrieval methods with library search behavior (per #1592).

Changes:

Introduces TvParentChildMixin._buildRelationKey() to append relation query params (including includeGuids by default).
Updates Show, Season, and Episode retrieval methods to use _buildRelationKey() when fetching related objects.
Adds/updates tests to assert GUID presence on related objects without relying on auto-reload behavior.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File	Description
`plexapi/video.py`	Switches show/season/episode relation fetches to use `_buildRelationKey()` so returned partials include GUIDs.
`plexapi/mixins/tv_parent_child.py`	Adds the new key-building helper for TV parent/child relations.
`plexapi/mixins/__init__.py`	Wires the new mixin into `ShowMixins`, `SeasonMixins`, and `EpisodeMixins`.
`tests/test_video.py`	Adds assertions/tests to validate GUID availability for related TV objects.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

plexapi/video.py

plexapi/mixins/tv_parent_child.py

tests/test_video.py

plexapi/video.py

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

…s parameters

…_season(), separating XML attributes from key construction.

Touchstone64 · 2026-03-16T12:00:20Z

The change to the key-building implementation in Episode._season() in this commit shows where my confusion started (and hopefully ends). Including an XML attribute in the key-building call worked (because the final query string was syntactically correct) but it was implementing completely the wrong pattern.

Episode._season() now stands as the perfect example of the way that _buildRelationalKey() and XML attributes should be used together in a fetchItem() call.

So sorry for the confusion!

Copilot

Pull request overview

Adds a shared key-builder to ensure TV show/season/episode relationship fetches include GUIDs (matching LibrarySection.search() behavior), and updates the relevant member methods plus tests to validate guid presence on partial objects.

Changes:

Introduce TvParentChildMixin._buildRelationalKey() to consistently append includeGuids=1 (and related query params) for parent/child fetch endpoints.
Update Show, Season, and Episode relationship/object-retrieval methods to use _buildRelationalKey(...).
Add/extend unit tests to assert guid parity for show/season/episode relationship methods without triggering auto-reloads.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
`plexapi/mixins/tv_parent_child.py`	New mixin to construct parent/child fetch keys with `includeGuids=1`.
`plexapi/mixins/__init__.py`	Wires `TvParentChildMixin` into `ShowMixins`, `SeasonMixins`, and `EpisodeMixins`.
`plexapi/video.py`	Switches TV relationship methods to use `_buildRelationalKey(...)` for guid parity.
`tests/test_video.py`	Adds tests verifying GUIDs are present on related partial objects without auto-reload.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

plexapi/video.py

plexapi/mixins/__init__.py

plexapi/mixins/tv_parent_child.py

…-child mixin.

JonnyWong16

One more change and it looks good.

Thanks for adding this.

plexapi/mixins/__init__.py

Touchstone64 · 2026-03-17T17:17:37Z

Final thought ... originally the intent was to provide a key-builder for objects that had some kind of parent-child relationship (episode <-> season <-> show), hence the name _buildRelationalKey(). Now that the method is more general-purpose, perhaps it would be better renamed, perhaps _buildQueryKey(). Up to you!

Either way, thanks for your time and support.

JonnyWong16 · 2026-03-17T17:22:29Z

_buildQueryKey() is a good idea.

JonnyWong16

Looks good. Thanks.

Touchstone64 and others added 9 commits March 11, 2026 17:28

Ensure data parity for seasons and episodes retrieved by section sear…

997f9e9

…chSeasons() and searchEpisodes() methods and Show.seasons() and Season.episodes() methods

Extract includeGuids inclusion for parent/child searches into a mixin

ba913e5

Implement the key-building mixin for all parent/child retrieval methods

6d600fe

Add unit tests for all permutations

31d261b

Fix the mistakes the unit tests inevitably show up

1532d20

Linting corrections (too many spaces)

47504f9

Linting corrections (trailing whitespace)

67630af

More linting issues

608190b

Merge branch 'master' into data-parity-for-seasons-and-episodes

f794705

JonnyWong16 requested a review from Copilot March 14, 2026 17:02

Copilot started reviewing on behalf of JonnyWong16 March 14, 2026 17:03 View session

Copilot AI reviewed Mar 14, 2026

View reviewed changes

Touchstone64 and others added 4 commits March 16, 2026 10:32

Preserve fetchItem's failure mode when encountering invalid keys

32d7cac

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Improve Season unit tests to provide partial objects have guids

f46d498

Change the relational key builder to explicitly support filters in it…

fabbe18

…s parameters

Correct the implementation of relational key construction in Episode.…

b96f421

…_season(), separating XML attributes from key construction.

JonnyWong16 requested a review from Copilot March 16, 2026 15:58

Copilot started reviewing on behalf of JonnyWong16 March 16, 2026 15:58 View session

Copilot AI reviewed Mar 16, 2026

View reviewed changes

plexapi/video.py Outdated Show resolved Hide resolved

plexapi/mixins/__init__.py Outdated Show resolved Hide resolved

Touchstone64 added 4 commits March 16, 2026 17:11

Add the TV parent-child mixin to the collection of composite mixins.

cfebc5e

Improve the statement of intent when building relational keys

6563636

Prevent test local variables from shadowing fixtures

db9668a

Move any parent-child query params into the key-building stage

88da1e0

JonnyWong16 requested changes Mar 17, 2026

View reviewed changes

plexapi/mixins/tv_parent_child.py Outdated Show resolved Hide resolved

plexapi/mixins/tv_parent_child.py Outdated Show resolved Hide resolved

Move the relational key builder into PlexObject and remove the parent…

85aa15b

…-child mixin.

Touchstone64 requested a review from JonnyWong16 March 17, 2026 10:04

JonnyWong16 requested changes Mar 17, 2026

View reviewed changes

plexapi/mixins/__init__.py Outdated Show resolved Hide resolved

Restore the trailing comma for Composite Mixins

b3dc7a6

Touchstone64 requested a review from JonnyWong16 March 17, 2026 17:18

Rename the relational key builder to be a query key builder

587618f

JonnyWong16 approved these changes Mar 18, 2026

View reviewed changes

JonnyWong16 merged commit ceb085d into pushingkarmaorg:master Mar 18, 2026
5 checks passed

Touchstone64 deleted the data-parity-for-seasons-and-episodes branch March 18, 2026 09:05

Conversation

Touchstone64 commented Mar 13, 2026

Description

Type of change

Checklist:

Uh oh!

Touchstone64 commented Mar 14, 2026

Uh oh!

JonnyWong16 commented Mar 14, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Touchstone64 commented Mar 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

JonnyWong16 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Touchstone64 commented Mar 17, 2026

Uh oh!

JonnyWong16 commented Mar 17, 2026

Uh oh!

JonnyWong16 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Touchstone64 commented Mar 16, 2026 •

edited

Loading